dbusServices/extensions: Await prefs.fillPreferencesWindow

There are cases where it makes sense to have fillPreferencesWindow be
async, so await it. One such case is when using .ui files from resources
with (GTK) templates. When extension developers load the resource in
`fillPreferencesWindow` and then import the js file that registers the
classes, there will be an error at the moment that there is no UI
provided. Similarly, make getPreferencesWidget async optionally.

Part-of: <https://gitlab.gnome.org/GNOME/gnome-shell/-/merge_requests/3348>

diff --git a/js/dbusServices/extensions/extensionPrefsDialog.js b/js/dbusServices/extensions/extensionPrefsDialog.js
index 9e3ea57ee59478d9754cebd5e3276df4f68cf4bf..6e6b4c8ceb9f02775cf181f04d09c874f9fcc2e4 100644 (file)
--- a/js/dbusServices/extensions/extensionPrefsDialog.js
+++ b/js/dbusServices/extensions/extensionPrefsDialog.js
@@ -38,7 +38,7 @@ export const ExtensionPrefsDialog = GObject.registerClass({
         const prefsObj = new prefsModule.default({...metadata, dir, path});
         this._extension.stateObj = prefsObj;
 
-        prefsObj.fillPreferencesWindow(this);
+        await prefsObj.fillPreferencesWindow(this);
 
         if (!this.visible_page)
             throw new Error('Extension did not provide any UI');

diff --git a/js/extensions/prefs.js b/js/extensions/prefs.js
index f36b9713832ef10f08331b54a2b842252c82f8d5..76ae3ca62c43937f0845c2a5d97031a050f406b3 100644 (file)
--- a/js/extensions/prefs.js
+++ b/js/extensions/prefs.js
@@ -18,7 +18,7 @@ export class ExtensionPreferences extends ExtensionBase {
      * Get the single widget that implements
      * the extension's preferences.
      *
-     * @returns {Gtk.Widget}
+     * @returns {Gtk.Widget|Promise<Gtk.Widget>}
      */
     getPreferencesWidget() {
         throw new GObject.NotImplementedError();
@@ -31,9 +31,10 @@ export class ExtensionPreferences extends ExtensionBase {
      * returned by getPreferencesWidget().
      *
      * @param {Adw.PreferencesWindow} window - the preferences window
+     * @returns {Promise<void>}
      */
-    fillPreferencesWindow(window) {
-        const widget = this.getPreferencesWidget();
+    async fillPreferencesWindow(window) {
+        const widget = await this.getPreferencesWidget();
         const page = this._wrapWidget(widget);
         window.add(page);
     }